docs: extend Adopting the framework section for PR-skill adopter contract#34
Merged
potiuk merged 1 commit intoMay 2, 2026
Merged
Conversation
…ract Two doc surfaces updated to surface the four PR-skill scaffold files added in apache#33: - **Top-level README `## Adopting the framework`** — restructured into four subsections: - `Bootstrapping a new adopter` — three concrete steps (submodule add, copy `_template/`, symlink `.claude/skills/`) with the actual commands; - `Per-skill-family contract` — splits the adopter's required `<project-config>/` files by skill family (security workflow vs PR triage and review). Adopters who use only one family can delete the other family's scaffold; - `How skills resolve <project-config>/ paths` — explains the pure-text placeholder convention so adopters don't go hunting for an env var or build step; - `Keeping the submodule current` — preserves the existing `git submodule update --init --recursive` post-merge-hook guidance. - **`projects/_template/README.md`** — adds a `### PR triage and review` subsection listing the four PR-skill scaffold files (`pr-triage-config.md`, `pr-triage-comment-templates.md`, `pr-triage-ci-check-map.md`, `pr-maintainer-review-criteria.md`) with per-file purpose and which skills consume them. The "Checklist after copying" splits into three groups (security workflow / PR triage and review / common finishers) so adopters who only use one family can skip the other group's checks. doctoc TOCs regenerated. Both surfaces carry the same disclaimer that the framework currently embeds airflow-flavoured defaults inline in the PR- skill supporting files; a follow-up PR completes the extraction. Until then non-airflow adopters override by forking the relevant supporting file into their own `.claude/skills/<skill-name>/`. Generated-by: Claude Code (Claude Opus 4.7)
andreahlert
added
the
mode:platform
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
## Adopting the frameworksection into four subsections:Bootstrapping a new adopter(concrete commands),Per-skill-family contract(security vs PR triage families),How skills resolve <project-config>/ paths, andKeeping the submodule current(preserves the existing post-merge-hook guidance).projects/_template/README.md: add a### PR triage and reviewsubsection listing the four scaffold files added in feat(skills): lift pr-triage, pr-stats, pr-maintainer-review #33 (pr-triage-config.md,pr-triage-comment-templates.md,pr-triage-ci-check-map.md,pr-maintainer-review-criteria.md) with per-file purpose. Split the "Checklist after copying" into three groups (security / PR / common finishers) so adopters using only one family can skip the other.Context
The four PR-skill scaffold files landed in #33 but the adoption flow was only briefly mentioned. This PR documents the contract end-to-end so a non-airflow project can:
git submodule add/cp -r/ln -scommands.<project-config>/files apply to their use case.projects/_template/README.md.Both surfaces carry the same disclaimer that the framework currently embeds airflow-flavoured defaults inline in the PR-skill supporting files; a follow-up PR completes the extraction. Until then, non-airflow adopters override by forking the relevant supporting file into their own
.claude/skills/<skill-name>/.Test plan
#adopting-the-frameworkand#pr-triage-and-reviewanchors preserved🤖 Generated with Claude Code